home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / UTIL / DESKTOP / SINGULARITY / !Snglarity / !Help < prev    next >
Text File  |  1995-03-08  |  15KB  |  334 lines
  1.  
  2.                                 SINGULARITY
  3.                                =============
  4.                Or: What happens when a Black Hole gets smaller. 
  5.                   
  6. Singularity is the sequel to the hugely popular and remarkably well
  7. programmed Black Hole II. It provides a very simple watsebin program which
  8. requires only about 6K of memory. It is completely transparent in use and
  9. provides a feature for 'ageing' of files in its bin so they don't clutter up
  10. your hard disc for too long.
  11.  
  12. So, what does it do then?
  13. =========================
  14.  
  15. When you delete a file (i.e. select 'Delete' from a Filer menu or type
  16. *delete on the command line), Singularity takes a copy of the file and puts
  17. it somewhere safe. It then lets the file be deleted, but now you have a
  18. backup copy of the file in a known place. It's really easy, innit?
  19.  
  20. Advantages over 'conventional' wastebins
  21. ========================================
  22.  
  23. Most wastebin programs work on the drag-and-drop principle - you drag a file
  24. to the wastebin and it takes a copy of the file then deletes it. The problem
  25. with this is that you can still delete files from the filer or the command
  26. line and lose them in the process. Singularity does not respond if you
  27. drag a file onto it. It simply intercepts ALL file deletions completely
  28. transparently and integrates much more neatly into your desktop. No more
  29. multiple-sets-of-options to worry about. No more 'Oh bugger I wish I'd
  30. dragged that file to the wastebin'. With Singularity running, you CANNOT
  31. delete a file without getting a backup copy.
  32.  
  33. How to Get Going
  34. ================
  35.  
  36. Double-click on !Snglarity and a small window will open, hopefully in the
  37. centre of the screen. This contains a logo, a Configure button, a Help!
  38. button, and an OK button. Ignore the Configure button for now. The Help!
  39. button will load this file. Click the OK button. The window will close and
  40. the Singularity icon will appear on the left hand side of your iconbar.
  41.  
  42. The icon will initially be a sort of small ball with four dark green spiky
  43. bits coming out of it. It will have the word 'On' underneath it. The small
  44. ball with the dark green spiky bits is Singularity's way of telling you that
  45. the Bin is empty. The word 'On' means Singularity is 'On' - i.e. it is
  46. waiting with baited breath for you to delete a file. But hold on a minute.
  47.  
  48. First, click with Select (the left mouse button) on the Singularity icon. The
  49. word underneath will change to 'Off'. This means Singularity is temporarily
  50. inactive. Click again on the icon and the word will change back to 'On'.
  51. Now find a file you don't want any more (or take a copy of one that you do)
  52. and Delete it. You should see your hard disc whir for a bit, then the
  53. Singularity icon will change to a larger ball with four light green spiky
  54. bits. This means that there is something in the Bin. Click the Right mouse
  55. button on the Singularity icon and the bin will be opened. It's a normal
  56. Filer directory just like any other.
  57.  
  58. Easy so far. Click the middle mouse button over the Singularity icon and you
  59. get a menu with three options. The top one is rather dull. The bottom one
  60. (Quit) kills Singularity off. The middle one is 'Contents'. This has a
  61. submenu with two options. The 'Destroy' option will empty the bin of all
  62. its contents (i.e. delete them permanently). The 'Count' option will count
  63. the contents and tell you how much disc space they take up.
  64.  
  65. The Bin
  66. =======
  67.  
  68. Singularity stores its copies in a Bin. It's not actually a Bin, because that
  69. would take up a lot of space and require regular visits from health and
  70. safety inspectors. It's actually a directory on your hard disc.
  71. Files that are copied into the Bin are placed in a subdirectory with a name
  72. of the form "xxxx_yy_zz" where xxxx is the year, yy is the month, and zz is
  73. the day. Thus we have a Root Bin and lots of sub-bins.
  74. Note - the ADFS can only cope with 77 objects in one directory. Thus if
  75. it gets to the stage where Singularity attempts to create the 78th directory
  76. it will fail and will not copy the files.
  77. I have not put a trap in to stop this because I hope that one day Acorn
  78. might fix this problem.
  79.  
  80. Configuring Singularity
  81. =======================
  82.  
  83. To Configure Singularity, run !Snglarity and Click on the 'Configure' button.
  84. This opens the Configuration window. There are some options.
  85.  
  86.  Ignore ADFS Floppy Discs : Makes Singularity ignore deletions from ADFS
  87.  floppy discs. This is usually a good thing, because you usually don't want
  88.  to keep backups of things on floppies. It also takes a long time.
  89.  
  90.  Put Bin on Iconbar : Puts the Root Bin on the iconbar as a Tiny Dir. You
  91.  can then double click on it to open it.
  92.  
  93.  Put Icon on Iconbar : Toggles whether Singularity appears on the iconbar.
  94.  Note that if you turn this off you won't be able to control Singularity
  95.  without using the command line, or access any of its menus.
  96.  
  97.  Sprites : You can choose which sprites to use for the iconbar sprites. The
  98.  default is a sort of green spiky ball. There's a much nicer one of a dustbin
  99.  that was designed by Richard Hallas. Many thanks to him.
  100.  
  101.  Delete Copies After : Things which have been in the bin longer than the
  102.  specified number of days will be deleted when Singularity is run. This means
  103.  Singularity acts as a safety buffer between you and your data and it 
  104.  prevents your hard disc from filling up with stuff you thought you'd deleted
  105.  months ago.
  106.  
  107.  Bin : Is the location of the Root Bin.
  108.  
  109.  Filing Systems to Ignore : Singularity can be made to ignore deletions from
  110.  certain Filing Systems - e.g. the RAM disc. To do this, just type the name
  111.  of the filing system in this icon. The name of the filing system is what
  112.  appears in its directory viewers before the double colon. For example, bring
  113.  up the root directory of your hard disc. The title bar will probably start
  114.  with ADFS:: or IDEFS:: or SCSIFS::, or if you're wierd, CFS#. In these cases
  115.  the filing system names are ADFS, IDEFS, SCSIFS, and CFS. For the RAM disc
  116.  it's RAM. So to ignore all operations taking place on ADFS discs and the RAM
  117.  disc, just type ADFS,RAM into the writeable icon.
  118.  
  119.  Note : Singularity cannot be made to Ignore certain types of filing system
  120.  which are known as image filing systems. Examples of Image filing systems
  121.  are SparkFS, ArcFS, and DOSFS.
  122.  
  123.  When you've finished, click 'Save' to save the options to disc. Hit 'Cancel'
  124.  to destroy all your hard work. The 'Help!' button loads this file.
  125.  
  126. Running Singularity on startup
  127. ==============================
  128.  
  129. There is nothing whatsoever to stop you from running !Snglarity in your
  130. desktop boot file by adding a line
  131.   Run <directory>.!Snglarity
  132. This will, of course, run Singularity and open the announcement window. Most
  133. people have complained about this. Therefore if you use the following:
  134.   Run <directory>.!Snglarity -nowindow
  135. the announcement window will not appear. Note that the -nowindow switch is
  136. CASE SENSITIVE. It must be all lower case. There is a very good reason for
  137. this apparrent sloppiness, and that reason is absolute laziness.
  138. And for all you clever dicks out there, do not attempt to start Singularity
  139. by just RMLoading the module. You have been warned.
  140.  
  141. Wait! There's More!
  142. ===================
  143.  
  144. Singularity does something else! Cor! This is something that Black Hole II
  145. also does, and that a lot of people find useful.
  146.  
  147. Let's suppose that you are in the process of saving a file from an
  148. application to disc. You've typed the filename into the Save As box of the
  149. application, and you've started to drag the file towards the directory
  150. viewer. Suddenly, with a horrible sinking feeling, you realise that you
  151. can't see the directory viewer! Aaaaaaagh! You've got to drop the file,
  152. open the directory viewer, then go through all the hoo-hah of saving the
  153. file again....
  154.  
  155. There are, however, two good things that are occurring:
  156.  
  157. 1) You're not using Windows on a PC. That happens all the time if you're
  158.    lucky, so bear that in mind.
  159.    
  160. 2) You are running Singularity! Don't fret any more! Don't drop that file!
  161.    Don't do drugs! (sorry, got carried away). Drag that file to the
  162.    Singularity icon and drop it there. Weyhey! Your file will be saved into
  163.    the ROOT bin directory. From there you can safely move it to wherever it
  164.    was you wanted to save it at your leisure.
  165.    
  166. Point to note: The file is saved in the ROOT bin directory. It WILL BE
  167. DELETED the next time you run !Snglarity. OK?
  168.  
  169. To remind you to move the file, Singularity opens the Root Bin directory
  170. once the file has been saved.
  171.  
  172. Point to note, the sequel: This is a cut down version of what Black Hole II
  173. allows you to do. With Black Hole, you can make it save files to different
  174. directories depending on their file types.
  175.  
  176. Some technical stuff (but not too technical)
  177. ============================================
  178.  
  179. Singularity is a module, which is how it manages to be small. Singularity is
  180. based on the Black Hole module that is distributed with Black Hole II. You
  181. cannot run Black Hole and Singularity at the same time, but since Black Hole
  182. provides all the features of Singularity and more, you'd have to be pretty
  183. bleedin' stupid to do that anyway.
  184.  
  185. Note also that because of the way it works, all directory structure will be
  186. lost when files are copied into the bin. If this is a problem and memory
  187. usage isn't, use Black Hole II.
  188.  
  189. It will ignore all disc operations which take place in Wimp$ScrapDir.
  190. If I didn't do this, all the temporay files placed in Wimp$ScrapDir by
  191. applications would be copied to the bin before being deleted. This is not
  192. particulary useful and I have seen applications crash because of this.
  193. To this end, you should make sure that if you own any applications which
  194. allow you to define a scrap directory just for them, you should define it
  195. somewhere in Wimp$ScrapDir.
  196. Note for the less competent: Wimp$ScrapDir is a directory used by all
  197. applications which want it as a place to store temporary files. Applications
  198. write a file into this directory, then delete it when they have finished.
  199. File compression programs such as Spark and CFS use Scrap directories.
  200. Wimp$ScrapDir is usually the directory !Scrap.ScrapDir. You can find out by
  201. pressing F12 and typing 'Show Wimp$ScrapDir'. Wherever it is, Singularity
  202. will find it and will ignore anything that happens inside it.
  203.  
  204. Memory Usage (slightly technical stuff)
  205. =======================================
  206.  
  207. Some people worry about this sort of thing. I don't but then I'm just like
  208. that. For the fanatical, here's a breakdown of Singularity's memory usage.
  209.  
  210.   Module itself        - 4412 bytes
  211.   Permanent workspace  - 1280 butes
  212.   Info window          -  248 bytes
  213.   ---------------------------------
  214.   TOTAL                  5940 bytes (6K)
  215.   
  216. You can't argue with that now, can you?
  217.  
  218. The Announcement/Configuration program requires a temporary 32K wimpslot.
  219. DO NOT attempt to run the Singularity module without going via the
  220. Configuration program. You have been warned.
  221.  
  222. The Singularity module (very technical stuff)
  223. =============================================
  224.  
  225. There are, I'm sure, a few people who still occasionally use the command line
  226. or other odd things. Well. Singularity, just because of the way it works,
  227. will also trap deletions made from the command line. There is a command line
  228. interface for controlling Singularity:
  229.  
  230.   *BinOn, *BinOff  -  The functions of which should be obvious.
  231.   *BinStatus       -  Which tells you whether the Bin is currently on or off.
  232.   *BinIgnore       -  Takes one parameter, which is the name of a Filing
  233.                       System to ignore. NOTE : If you do use this, you MUST
  234.                       make certain that the total length of all the filing
  235.                       system names added to Singularity is less than 128
  236.                       bytes. The !Snglarity program does this so the module
  237.                       DOES NOT check.
  238.   *BinIgnoreClear  -  Clears the list of filing systems to ignore.
  239.   *BinCatchADFSFloppies and *BinIgnoreADFSFloppies should be obvious.
  240.   
  241. One interesting side effect of running Singularity is that you can quickly
  242. find out which applications use a temp file that isn't inside Wimp$ScrapDir,
  243. because Singularity copies it over as soon as the application tries to
  244. delete it.
  245.  
  246. Ignored Device Filing Systems (Horendously Technical Stuff)
  247. ===========================================================
  248.  
  249. RISC OS 3 implements a lot of devices as pseudo-filing systems. One example
  250. is the parallel port. Singularity will ignore all the device filing systems
  251. that I currently know about.
  252.  
  253. The code to do this is quick and therefore should not measurably slow down
  254. the response of these systems.
  255.  
  256. For insterested parties, the filing systems (and their numbers) that are
  257. ignored are:
  258.  
  259.    NetPrint (12)
  260.    Null (13)
  261.    Printer (14)
  262.    Serial (15)
  263.    Vdu (17)
  264.    RawVdu (18)
  265.    Kbd (19)
  266.    RawKbd (20)
  267.    DeskFS (21)
  268.    Computer Concepts RomFS (22)
  269.    Streamer (25)
  270.    Digitiser (27)
  271.    Scanner (28)
  272.    PipeFS (47)
  273.    DeviceFS (53)
  274.    Parallel (54)
  275.  
  276. Disclaimer:
  277. ===========
  278.  
  279. This program is supplied 'as is' with no guarantee of its suitability for any
  280. purpose. I will not be held responsible for any loss of data occuring through
  281. the use or misuse of this program.
  282. If anything goes wrong with Singularity then I DO NOT want to hear about it.
  283. Well, maybe if you tell me gently and accompany your communication with
  284. something to lessen the blow, such as a vast sum of money.
  285.  
  286. Public Domain Notice:
  287. =====================
  288.  
  289. Singularity is released by courtesy of the Fat German in association with the
  290. Great Green Gollywog and his minions. The King of the Potato People would
  291. like to point out that he is not responsible for this, or for anything else
  292. for that matter.
  293. This software may be freely copied and used, as long as the following
  294. conditions are met:
  295.  
  296. a) That this notice is distributed unchanged with every copy.
  297. b) That no modifications are made to any part of the code or other files.
  298. c) No charge is made for the distribution. Public domain libraries may make
  299.    a small charge to cover distribution costs. It is highly unethical, not
  300.    to mention dishonest to make a charge for software which programmers
  301.    have intended to be freely distributed, especially if none of that profit
  302.    finds its way to the programmer.
  303. d) You do at least one thing to promote peace and harmony between all the
  304.    peoples of the world. Including potatoes. And gollywogs.
  305.  
  306. All copyright is reserved. Anybody who uses my code in a project which is
  307. intended to be sold for profit is a foul scumbag. Unless they give me some
  308. money too, then it's allright.
  309.  
  310. If you wish to use pieces of my code in your own pd programs then please feel
  311. free to do so, provided these programs are not intented for sale. If you do
  312. use my code, a credit would be nice. Money would be even better.
  313.  
  314. I can be contacted via the remarkable British postal service at:
  315.    Mark Greenwood,
  316.    122 Miswell Lane,
  317.    Tring,
  318.    Herts. HP23 4EU
  319.    England
  320.    
  321. Or via the slightly quicker but infinitiely less reliable wonders of
  322. telecommunications science at
  323.  
  324.    1) mgreenwo@madge1.demon.co.uk 
  325.    
  326.    which is reliable but UNIX based (Aaaaaaaaaagh!), therefore
  327.    
  328.    2) mgreenwo@madge.com
  329.    
  330.    is preferable if slightly slower.
  331.      
  332.                    Thanks to Dave for inventing Fat German.
  333.                    
  334.